<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>NVTX C API Reference: nvtxCounterAttr_t Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">NVTX C API Reference<span id="projectnumber">&#160;v3</span>
   </div>
   <div id="projectbrief">NVIDIA Tools Extension Library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle"><div class="title">nvtxCounterAttr_t Struct Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Attributes of a counter or counter group.  
 <a href="structnvtx_counter_attr__t.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="nv_tools_ext_counters_8h_source.html">nvToolsExtCounters.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a9edd1b2ed8eae21453b6bdd561b7042f" id="r_a9edd1b2ed8eae21453b6bdd561b7042f"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnvtx_counter_attr__t.html#a9edd1b2ed8eae21453b6bdd561b7042f">structSize</a></td></tr>
<tr class="separator:a9edd1b2ed8eae21453b6bdd561b7042f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a383083b3ae94dedfb59ddca685abe0eb" id="r_a383083b3ae94dedfb59ddca685abe0eb"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnvtx_counter_attr__t.html#a383083b3ae94dedfb59ddca685abe0eb">schemaId</a></td></tr>
<tr class="separator:a383083b3ae94dedfb59ddca685abe0eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9bc076586c6c5627632eb1bcd70b861e" id="r_a9bc076586c6c5627632eb1bcd70b861e"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnvtx_counter_attr__t.html#a9bc076586c6c5627632eb1bcd70b861e">name</a></td></tr>
<tr class="separator:a9bc076586c6c5627632eb1bcd70b861e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a029534e6f708be20dbb6e220474b2d52" id="r_a029534e6f708be20dbb6e220474b2d52"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnvtx_counter_attr__t.html#a029534e6f708be20dbb6e220474b2d52">description</a></td></tr>
<tr class="separator:a029534e6f708be20dbb6e220474b2d52"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a02bba10c2782ffd40efb00155b163917" id="r_a02bba10c2782ffd40efb00155b163917"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnvtx_counter_attr__t.html#a02bba10c2782ffd40efb00155b163917">scopeId</a></td></tr>
<tr class="separator:a02bba10c2782ffd40efb00155b163917"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2ab25966e298a5742776ae1aa3bdf401" id="r_a2ab25966e298a5742776ae1aa3bdf401"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structnvtx_semantics_header__t.html">nvtxSemanticsHeader_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnvtx_counter_attr__t.html#a2ab25966e298a5742776ae1aa3bdf401">semantics</a></td></tr>
<tr class="separator:a2ab25966e298a5742776ae1aa3bdf401"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a74a6483547eb7f7946020dc2ffcf84fe" id="r_a74a6483547eb7f7946020dc2ffcf84fe"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnvtx_counter_attr__t.html#a74a6483547eb7f7946020dc2ffcf84fe">counterId</a></td></tr>
<tr class="separator:a74a6483547eb7f7946020dc2ffcf84fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Attributes of a counter or counter group. </p>

<p class="definition">Definition at line <a class="el" href="nv_tools_ext_counters_8h_source.html#l00095">95</a> of file <a class="el" href="nv_tools_ext_counters_8h_source.html">nvToolsExtCounters.h</a>.</p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="a74a6483547eb7f7946020dc2ffcf84fe" name="a74a6483547eb7f7946020dc2ffcf84fe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a74a6483547eb7f7946020dc2ffcf84fe">&#9670;&#160;</a></span>counterId</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint64_t nvtxCounterAttr_t::counterId</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>A static counter ID must be unique within the domain, &gt;= NVTX_COUNTER_ID_STATIC_START, and &lt; NVTX_COUNTER_ID_DYNAMIC_START. Use NVTX_COUNTER_ID_NONE to let the tool create a (dynamic) counter ID. </p>

<p class="definition">Definition at line <a class="el" href="nv_tools_ext_counters_8h_source.html#l00136">136</a> of file <a class="el" href="nv_tools_ext_counters_8h_source.html">nvToolsExtCounters.h</a>.</p>

</div>
</div>
<a id="a029534e6f708be20dbb6e220474b2d52" name="a029534e6f708be20dbb6e220474b2d52"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a029534e6f708be20dbb6e220474b2d52">&#9670;&#160;</a></span>description</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* nvtxCounterAttr_t::description</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Optional detailed description of the counter (group). A description for individual counters can be set in the schema registration. </p>

<p class="definition">Definition at line <a class="el" href="nv_tools_ext_counters_8h_source.html#l00112">112</a> of file <a class="el" href="nv_tools_ext_counters_8h_source.html">nvToolsExtCounters.h</a>.</p>

</div>
</div>
<a id="a9bc076586c6c5627632eb1bcd70b861e" name="a9bc076586c6c5627632eb1bcd70b861e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9bc076586c6c5627632eb1bcd70b861e">&#9670;&#160;</a></span>name</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* nvtxCounterAttr_t::name</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Name of the counter (group). </p>

<p class="definition">Definition at line <a class="el" href="nv_tools_ext_counters_8h_source.html#l00106">106</a> of file <a class="el" href="nv_tools_ext_counters_8h_source.html">nvToolsExtCounters.h</a>.</p>

</div>
</div>
<a id="a383083b3ae94dedfb59ddca685abe0eb" name="a383083b3ae94dedfb59ddca685abe0eb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a383083b3ae94dedfb59ddca685abe0eb">&#9670;&#160;</a></span>schemaId</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint64_t nvtxCounterAttr_t::schemaId</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>A schema ID referring to the data layout of the counter group or a predefined NVTX payloads number type. </p>

<p class="definition">Definition at line <a class="el" href="nv_tools_ext_counters_8h_source.html#l00103">103</a> of file <a class="el" href="nv_tools_ext_counters_8h_source.html">nvToolsExtCounters.h</a>.</p>

</div>
</div>
<a id="a02bba10c2782ffd40efb00155b163917" name="a02bba10c2782ffd40efb00155b163917"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a02bba10c2782ffd40efb00155b163917">&#9670;&#160;</a></span>scopeId</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint64_t nvtxCounterAttr_t::scopeId</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Identifier of the counters' scope. A valid scope ID is either a predefined scope or the value returned by <code>nvtxScopeRegister</code> called for the same NVTX domain as <code>nvtxCounterRegister</code>. An invalid scope ID will be handled like <code>NVTX_SCOPE_NONE</code>. </p>

<p class="definition">Definition at line <a class="el" href="nv_tools_ext_counters_8h_source.html#l00120">120</a> of file <a class="el" href="nv_tools_ext_counters_8h_source.html">nvToolsExtCounters.h</a>.</p>

</div>
</div>
<a id="a2ab25966e298a5742776ae1aa3bdf401" name="a2ab25966e298a5742776ae1aa3bdf401"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2ab25966e298a5742776ae1aa3bdf401">&#9670;&#160;</a></span>semantics</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="structnvtx_semantics_header__t.html">nvtxSemanticsHeader_t</a>* nvtxCounterAttr_t::semantics</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Optional semantics for a counter (group). The specified semantics apply to all counters in a group. If the semantics should only refer to a single counter in a group, the semantics field of the payload entry has to be used. Accepted semantics are <code><a class="el" href="structnvtx_semantics_counter__t.html" title="Specify additional properties of a counter or counter group.">nvtxSemanticsCounter_t</a></code> and <code><a class="el" href="structnvtx_semantics_time__t.html">nvtxSemanticsTime_t</a></code>. </p>

<p class="definition">Definition at line <a class="el" href="nv_tools_ext_counters_8h_source.html#l00129">129</a> of file <a class="el" href="nv_tools_ext_counters_8h_source.html">nvToolsExtCounters.h</a>.</p>

</div>
</div>
<a id="a9edd1b2ed8eae21453b6bdd561b7042f" name="a9edd1b2ed8eae21453b6bdd561b7042f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9edd1b2ed8eae21453b6bdd561b7042f">&#9670;&#160;</a></span>structSize</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t nvtxCounterAttr_t::structSize</td>
        </tr>
      </table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="nv_tools_ext_counters_8h_source.html#l00097">97</a> of file <a class="el" href="nv_tools_ext_counters_8h_source.html">nvToolsExtCounters.h</a>.</p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="nv_tools_ext_counters_8h_source.html">nvToolsExtCounters.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>
